TreeAdmin Class Reference

Inheritance diagram for TreeAdmin:

List of all members.

Public Member Functions
	TreeAdmin ()
	moveNode ($tomoveid, $destinationid)
	isValidMove ($tomove, $dest)
	duplicateCourse ($courseid, $destinationid)
	newNode ($parentid, $caption, $description=NULL)
	newLeaf ($parentid, $courseid, $caption, $description=NULL)
	createNode ($parentid=NULL, $courseid=NULL, $caption=NULL, $description=NULL, $type=NULL)
	editNode ($nodeId, $newCaption=NULL, $newDescription=NULL)
	deleteNode ($nodeId)
	newNodeInputMask ($parentId)
	editNodeInputMask ($nodeId)
	confirmDelete ($nodeId)
	getNewNodeForm ($parentId)
	getEditNodeForm ($nodeId)
	getConfirmationForm ($text, $action)
	getNodeIdByCourseId ($courseid)
Private Member Functions
	clearCourseTreeCache ()

---

Member Function Documentation

TreeAdmin::clearCourseTreeCache

(

)

[private]

TreeAdmin::confirmDelete

(

$

nodeId

)

Zeigt den Bestätigungsdialog zum Löschen an. public

Returns:

void

Implements InterfaceTreeAdmin.

TreeAdmin::createNode	(	$	parentid = NULL,
		$	courseid = NULL,
		$	caption = NULL,
		$	description = NULL,
		$	type = NULL
	)

Erstellt einen neuen Eintrag in der coursetree Tabelle. private

Parameters:

	$parentid	int Die ID des übergeordneten Eintrags
	$courseid	int Die ID des Kurses auf den Verwiesen wird
	$caption	string Der Name des Knotens
	$description	string Die Beschreibung des Knotens
	$type	string Der Typ des Eintrags (um welche Organisationseinheit handelt es sich?)

Returns:

bool Je nachdem ob der Eintrag anglegt wurde oder nicht.

Implements InterfaceTreeAdmin.

TreeAdmin::deleteNode

(

$

nodeId

)

Entfernt einen Knoten aus dem Baum. public

Parameters:

$nodeid

int Die ID des Knotens der gelöscht werden soll

Implements InterfaceTreeAdmin.

TreeAdmin::duplicateCourse	(	$	courseid,
		$	destinationid
	)

Macht einen vorhandenen Kurs an einer anderen Stelle verfügbar. public

Parameters:

	$courseid	int Die ID des Kurses
	$destinationid	int Die ID des zukünftigen Elternelements

Returns:

mixed

Implements InterfaceTreeAdmin.

TreeAdmin::editNode	(	$	nodeId,
		$	newCaption = NULL,
		$	newDescription = NULL
	)

Bearbeitet einen Knoten im Baum. public

Parameters:

	$nodeid	int Die ID des Knotens der bearbeitet werden soll
	$newCaption	string NULL oder die neue Bezeichnung
	$newDescription	string NULL oder die neue Beschreibung

Implements InterfaceTreeAdmin.

TreeAdmin::editNodeInputMask

(

$

nodeId

)

Zeigt das Eingabeformular für einen neuen Knoten an. public

Returns:

void

Implements InterfaceTreeAdmin.

TreeAdmin::getConfirmationForm	(	$	text,
		$	action
	)

Gibt das PEAR HTML_QuickForm Formular für einen bestätigungs Dialg zurück. public

Parameters:

	$text	string Dialog-Text
	$action	string Ziel für das Formular

Returns:

Das HTML_QuickForm Objekt

Implements InterfaceTreeAdmin.

TreeAdmin::getEditNodeForm

(

$

nodeId

)

Gibt das PEAR HTML_QuickForm Formular zum editieren eines Knotens zurück. public

Parameters:

$parentId

int Die ID des Knotens zum editieren

Returns:

Das HTML_QuickForm Objekt

Implements InterfaceTreeAdmin.

TreeAdmin::getNewNodeForm

(

$

parentId

)

Gibt das PEAR HTML_QuickForm Formular zum anlegen eines neuen Knotens zurück. public

Parameters:

$parentId

int Die ID des übergeordneten Knotens

Returns:

Das HTML_QuickForm Objekt

Implements InterfaceTreeAdmin.

TreeAdmin::getNodeIdByCourseId

(

$

courseid

)

Gibt die node-id zu einem verknüpften Kurs zurück.

Parameters:

$courseid

int Die Kurs ID

Returns:

Die ID des Knoteneintrags

Implements InterfaceTreeAdmin.

TreeAdmin::isValidMove	(	$	tomove,
		$	dest
	)

Überprüft ob eine geplante verschiebe Aktion im Baum einen gueltigen Baum hinterlaesst.

Implements InterfaceTreeAdmin.

TreeAdmin::moveNode	(	$	tomoveid,
		$	destinationid
	)

Verschiebt den Eintrag mit der ID $tomoveid im Baum als Kind des Knotens mit der ID $destinationid. public

Parameters:

	$tomoveid	int Die ID des zu verschiebenenden Eintrags
	$destinationid	int Die ID des zukünftigen Elternelements

Returns:

mixed true bei Erfolgsfall false bei Fehler

Implements InterfaceTreeAdmin.

TreeAdmin::newLeaf	(	$	parentid,
		$	courseid,
		$	caption,
		$	description = NULL
	)

Erstellt einen neuen Knoten vom Typ "Blatt" im Baum. (In unserem Fall ein "Kurs"); public

Parameters:

	$parentid	int Die ID des Übergeordneten Knotens
	$courseid	int Die ID des Kurses auf den dieser Eintrag verweist
	$caption	string Der Name des Eintags
	$description	string Die Beschreibung des Eintrags

Returns:

bool true/false, je nach dem ob der Eintrag erstellt werden konnte oder nicht.

Implements InterfaceTreeAdmin.

TreeAdmin::newNode	(	$	parentid,
		$	caption,
		$	description = NULL
	)

Erstellt einen neuen Knoten im Baum. public

Parameters:

	$parentid	int Die ID des Übergeordneten Knotens
	$caption	string Der Name des Eintags
	$description	string Die Beschreibung des Eintrags

Returns:

bool true/false, je nach dem ob der Eintrag erstellt werden konnte oder nicht.

Implements InterfaceTreeAdmin.

TreeAdmin::newNodeInputMask

(

$

parentId

)

Zeigt das Eingabeformular für einen neuen Knoten an. public

Returns:

void

Implements InterfaceTreeAdmin.

TreeAdmin::TreeAdmin

(

)

Default-Konstruktor. public

---

The documentation for this class was generated from the following file:

• web/courses/classes/class.treeadmin.inc.php